<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title>Docs For Class DefaultAuditor</title>
  <link rel="stylesheet" href="../media/stylesheet.css" />
  <script src="../media/lib/classTree.js"></script>
<link id="webfx-tab-style-sheet" type="text/css" rel="stylesheet" href="../media/lib/tab.webfx.css" />
<script type="text/javascript" src="../media/lib/tabpane.js"></script>
  <script language="javascript" type="text/javascript" src="../media/lib/ua.js"></script>
<script language="javascript" type="text/javascript">
	var imgPlus = new Image();
	var imgMinus = new Image();
	imgPlus.src = "../media/images/plus.gif";
	imgMinus.src = "../media/images/minus.gif";
	
	function showNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgMinus.src;
		oTable.style.display = "block";
	}
	
	function hideNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgPlus.src;
		oTable.style.display = "none";
	}
	
	function nodeIsVisible(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
        		break;
        }
		return (oTable && oTable.style.display == "block");
	}
	
	function toggleNodeVisibility(Node){
		if (nodeIsVisible(Node)){
			hideNode(Node);
		}else{
			showNode(Node);
		}
	}
</script>
<!-- template designed by Julien Damon based on PHPEdit's generated templates, and tweaked by Greg Beaver -->
<body bgcolor="#ffffff" ><!-- Start of Class Data -->
<h2>
	Class DefaultAuditor
</h2> (line <span class="linenumber">49</span>)
<div class="tab-pane" id="tabPane1">
<script type="text/javascript">
tp1 = new WebFXTabPane( document.getElementById( "tabPane1" ));
</script>

<div class="tab-page" id="Description">
<h2 class="tab">Description</h2>
<pre>
</pre>
<p>
	<b><i>Located in File: <a href="_reference---DefaultAuditor.php.html">/reference/DefaultAuditor.php</a></i></b><br>
</p>
<!-- ========== Info from phpDoc block ========= -->
<h5>Reference Implementation of the Auditor interface.</h5>
<ul>
		<li><strong>author:</strong> - Mike Boberski &lt;<a href="mailto:boberski_michael@bah.com">boberski_michael@bah.com</a>&gt;</li>
		<li><strong>author:</strong> - Laura Bell &lt;<a href="mailto:laura.d.bell@gmail.com">laura.d.bell@gmail.com</a>&gt;</li>
		<li><strong>author:</strong> - Andrew van der Stock &lt;<a href="mailto:vanderaj@owasp.org">vanderaj@owasp.org</a>&gt;</li>
		<li><strong>author:</strong> - jah &lt;<a href="mailto:jah@jahboite.co.uk">jah@jahboite.co.uk</a>&gt;</li>
		<li><strong>version:</strong> - Release: @package_version@</li>
		<li><strong>copyright:</strong> - 2009-2010 The OWASP Foundation</li>
		<li><strong>link:</strong> - <a href="http://www.owasp.org/index.php/ESAPI">http://www.owasp.org/index.php/ESAPI</a></li>
		<li><strong>license:</strong> - <a href="http://www.opensource.org/licenses/bsd-license.php">New BSD license</a></li>
	</ul>
<br /><hr />
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "Description" ) );</script>
<div class="tab-page" id="tabPage1">

<h2 class="tab">Class Variables</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<hr />
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage1" ) );</script>
</div>
<div class="tab-page" id="constantsTabpage">

<h2 class="tab">Class Constants</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<hr />
<script type="text/javascript">tp1.addTabPage( document.getElementById( "constantsTabpage" ) );</script>
</div>
<div class="tab-page" id="tabPage2">
<h2 class="tab">Method Detail</h2>
<!-- ============ METHOD DETAIL =========== -->
<strong>Summary:</strong><br />
<div class="method-summary">
    <div class="method-definition">
            <span class="method-result">does</span>
        <a href="#method__construct" title="details" class="method-name">__construct</a>
        (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methoddebug" title="details" class="method-name">debug</a>
        (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$success</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$throwable</span> = <span class="var-default">null</span>])
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methoderror" title="details" class="method-name">error</a>
        (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$success</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$throwable</span> = <span class="var-default">null</span>])
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodfatal" title="details" class="method-name">fatal</a>
        (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$success</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$throwable</span> = <span class="var-default">null</span>])
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodinfo" title="details" class="method-name">info</a>
        (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$success</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$throwable</span> = <span class="var-default">null</span>])
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodisDebugEnabled" title="details" class="method-name">isDebugEnabled</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodisErrorEnabled" title="details" class="method-name">isErrorEnabled</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodisFatalEnabled" title="details" class="method-name">isFatalEnabled</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodisInfoEnabled" title="details" class="method-name">isInfoEnabled</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodisTraceEnabled" title="details" class="method-name">isTraceEnabled</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodisWarningEnabled" title="details" class="method-name">isWarningEnabled</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodsetLevel" title="details" class="method-name">setLevel</a>
        (<span class="var-type"></span>&nbsp;<span class="var-name">$level</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodtrace" title="details" class="method-name">trace</a>
        (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$success</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$throwable</span> = <span class="var-default">null</span>])
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodwarning" title="details" class="method-name">warning</a>
        (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$success</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$throwable</span> = <span class="var-default">null</span>])
        </div>
</div>
<hr />
<A NAME='method_detail'></A>


<a name="method__construct" id="method__construct"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/Constructor.gif" border="0" /> <strong class="method">Constructor __construct</strong> (line <span class="linenumber">69</span>)
 </h4> 
<h4><i>does</i> <strong>__construct(
string
$name)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>DefaultAuditor constructor.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>string $name</strong>: logger name.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - not return a value.</li>
		</ul>
</div>
<a name="methoddebug" id="methoddebug"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method debug</strong> (line <span class="linenumber">182</span>)
 </h4> 
<h4><i>void</i> <strong>debug(

$type, 
$success, 
$message, [
$throwable = null])</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/Auditor.html#methoddebug">Auditor::debug()</a></dt>
						<dd>Log a debug level security event if 'debug' level logging is enabled and  also record the stack trace associated with the event.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		<h4>Parameters</h4>
	<ul>
			<li><strong> $type</strong>: </li>
			<li><strong> $success</strong>: </li>
			<li><strong> $message</strong>: </li>
			<li><strong> $throwable</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methoderror" id="methoderror"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method error</strong> (line <span class="linenumber">128</span>)
 </h4> 
<h4><i>void</i> <strong>error(

$type, 
$success, 
$message, [
$throwable = null])</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/Auditor.html#methoderror">Auditor::error()</a></dt>
						<dd>Log an error level security event if 'error' level logging is enabled and  also record the stack trace associated with the event.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		<h4>Parameters</h4>
	<ul>
			<li><strong> $type</strong>: </li>
			<li><strong> $success</strong>: </li>
			<li><strong> $message</strong>: </li>
			<li><strong> $throwable</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodfatal" id="methodfatal"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method fatal</strong> (line <span class="linenumber">110</span>)
 </h4> 
<h4><i>void</i> <strong>fatal(

$type, 
$success, 
$message, [
$throwable = null])</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/Auditor.html#methodfatal">Auditor::fatal()</a></dt>
						<dd>Log a fatal level security event if 'fatal' level logging is enabled and  also record the stack trace associated with the event.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		<h4>Parameters</h4>
	<ul>
			<li><strong> $type</strong>: </li>
			<li><strong> $success</strong>: </li>
			<li><strong> $message</strong>: </li>
			<li><strong> $throwable</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodinfo" id="methodinfo"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method info</strong> (line <span class="linenumber">164</span>)
 </h4> 
<h4><i>void</i> <strong>info(

$type, 
$success, 
$message, [
$throwable = null])</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/Auditor.html#methodinfo">Auditor::info()</a></dt>
						<dd>Log an info level security event if 'info' level logging is enabled and  also record the stack trace associated with the event.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		<h4>Parameters</h4>
	<ul>
			<li><strong> $type</strong>: </li>
			<li><strong> $success</strong>: </li>
			<li><strong> $message</strong>: </li>
			<li><strong> $throwable</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodisDebugEnabled" id="methodisDebugEnabled"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isDebugEnabled</strong> (line <span class="linenumber">191</span>)
 </h4> 
<h4><i>void</i> <strong>isDebugEnabled(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/Auditor.html#methodisDebugEnabled">Auditor::isDebugEnabled()</a></dt>
						<dd>Allows the caller to determine if messages logged at this level will be  discarded, to avoid performing expensive processing.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodisErrorEnabled" id="methodisErrorEnabled"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isErrorEnabled</strong> (line <span class="linenumber">137</span>)
 </h4> 
<h4><i>void</i> <strong>isErrorEnabled(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/Auditor.html#methodisErrorEnabled">Auditor::isErrorEnabled()</a></dt>
						<dd>Allows the caller to determine if messages logged at this level will be  discarded, to avoid performing expensive processing.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodisFatalEnabled" id="methodisFatalEnabled"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isFatalEnabled</strong> (line <span class="linenumber">119</span>)
 </h4> 
<h4><i>void</i> <strong>isFatalEnabled(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/Auditor.html#methodisFatalEnabled">Auditor::isFatalEnabled()</a></dt>
						<dd>Allows the caller to determine if messages logged at this level will be  discarded, to avoid performing expensive processing.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodisInfoEnabled" id="methodisInfoEnabled"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isInfoEnabled</strong> (line <span class="linenumber">173</span>)
 </h4> 
<h4><i>void</i> <strong>isInfoEnabled(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/Auditor.html#methodisInfoEnabled">Auditor::isInfoEnabled()</a></dt>
						<dd>Allows the caller to determine if messages logged at this level will be  discarded, to avoid performing expensive processing.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodisTraceEnabled" id="methodisTraceEnabled"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isTraceEnabled</strong> (line <span class="linenumber">209</span>)
 </h4> 
<h4><i>void</i> <strong>isTraceEnabled(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/Auditor.html#methodisTraceEnabled">Auditor::isTraceEnabled()</a></dt>
						<dd>Allows the caller to determine if messages logged at this level will be  discarded, to avoid performing expensive processing.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodisWarningEnabled" id="methodisWarningEnabled"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isWarningEnabled</strong> (line <span class="linenumber">155</span>)
 </h4> 
<h4><i>void</i> <strong>isWarningEnabled(
)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/Auditor.html#methodisWarningEnabled">Auditor::isWarningEnabled()</a></dt>
						<dd>Allows the caller to determine if messages logged at this level will be  discarded, to avoid performing expensive processing.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodsetLevel" id="methodsetLevel"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setLevel</strong> (line <span class="linenumber">87</span>)
 </h4> 
<h4><i>void</i> <strong>setLevel(

$level)</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/Auditor.html#methodsetLevel">Auditor::setLevel()</a></dt>
						<dd>Dynamically set the logging severity level. All events of this level and  higher will be logged from this point forward for all logs. All events  below this level will be discarded.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		<h4>Parameters</h4>
	<ul>
			<li><strong> $level</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>access</strong> - public</li>
		</ul>
</div>
<a name="methodtrace" id="methodtrace"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method trace</strong> (line <span class="linenumber">200</span>)
 </h4> 
<h4><i>void</i> <strong>trace(

$type, 
$success, 
$message, [
$throwable = null])</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/Auditor.html#methodtrace">Auditor::trace()</a></dt>
						<dd>Log a trace level security event if 'trace' level logging is enabled and  also record the stack trace associated with the event.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		<h4>Parameters</h4>
	<ul>
			<li><strong> $type</strong>: </li>
			<li><strong> $success</strong>: </li>
			<li><strong> $message</strong>: </li>
			<li><strong> $throwable</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodwarning" id="methodwarning"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method warning</strong> (line <span class="linenumber">146</span>)
 </h4> 
<h4><i>void</i> <strong>warning(

$type, 
$success, 
$message, [
$throwable = null])</strong></h4>

			<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../ESAPI/Auditor.html#methodwarning">Auditor::warning()</a></dt>
						<dd>Log a warning level security event if 'warning' level logging is enabled and  also record the stack trace associated with the event.</dd>
					</dl>
		<!-- ========== Info from phpDoc block ========= -->
		<h4>Parameters</h4>
	<ul>
			<li><strong> $type</strong>: </li>
			<li><strong> $success</strong>: </li>
			<li><strong> $message</strong>: </li>
			<li><strong> $throwable</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage2" ) );</script></div>
<div class="tab-page" id="iVars">
<h2 class="tab">Inherited Variables</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iVars" ) );</script>
<!-- =========== VAR INHERITED SUMMARY =========== -->
<A NAME='var_inherited_summary'><!-- --></A>
<h3>Inherited Class Variable Summary</h3>

	</div>
<div class="tab-page" id="iMethods">
<h2 class="tab">Inherited Methods</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iMethods" ) );</script>
<!-- =========== INHERITED METHOD SUMMARY =========== -->
<A NAME='functions_inherited'><!-- --></A>
<h3>Inherited Method Summary</h3>

	</div>
</div>
<script type="text/javascript">
//<![CDATA[

setupAllTabs();

//]]>
</script>
	<div id="credit">
		<hr />
		Documentation generated on Thu, 20 May 2010 16:30:19 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</div>
</body>
</html>